home *** CD-ROM | disk | FTP | other *** search
/ InfoMagic Internet Tools 1995 April / Internet Tools.iso / x25 / nrs.shar.Z / nrs.shar / README < prev    next >
Encoding:
Text File  |  1990-04-27  |  4.9 KB  |  131 lines
  1. # RCSid[] = "@(#)$Header: README,v 3.2 87/05/16 06:19:25 pb Rel $"
  2.  
  3.     The new definitive C nrs database processor!!!
  4.  
  5. OK chaps, this version is about an order of magnitude larger than the
  6. awk scripts but it does have some added features.
  7.  
  8. 1)    It uses the derived file (or atomic files) rather than
  9.     the t.central file which is more ``official''.
  10. 2)    It can output in a variety of formats.
  11. 3)    It's pretty much unix independant.
  12. 4)    It's much faster.
  13. 5)    It runs on VMS
  14. 6)    It runs on PR1MEs
  15.  
  16. The heart of the system is the configuration file which is the only
  17. argument given to nrs. It specifies all the bits that you might need.
  18. For more details see the document nrs.ms
  19.  
  20. Building it.
  21. ============
  22.  
  23. Basically, you just type make and it'll build itself.
  24. However there are one or two things you can fiddle with to help it along.
  25. [on VMS: @make; on PR1ME: r configure then r make]
  26.  
  27. On UNIX sites the initial make runs Configure which does all the
  28. configuration work for you. It discovers the system info by poking
  29. around, and asks the user about the desired options.  It remembers the
  30. information from the first run of Configure, so you should not be asked
  31. again. Mmdf and sendmail formats send their output to a number of
  32. different files. The standard ones (uk.ac, uk.co, etc) are in the main
  33. .cf files, but most sites want to add their own. If you want either of
  34. these formats, you should create a file called tailor in the current
  35. directory with lines of the form (see the Jog for details):
  36. filedmn    cl.dom        uk.ac.cam.cl.    uk.ac.cambridge.computer-lab.
  37. filedmn    cam.dom        uk.ac.cam.    uk.ac.cambridge.
  38. If you do not want to do any local tailoring, create a null tailor file.
  39. If it doesn't find a tailor file when configuring, it will ask you a
  40. junk question to allow you to use a sub-shell to create the file.
  41. Configure quick zips throught without checking with the user.
  42. Configure all asks every question, even if it thinks it knows the answer
  43.  
  44. On VMS sites the configuration has to be done by creating a file called
  45. localconf.com which is obeyed after stdconf.com so will override the
  46. standard configuration variables.  It should also define LOCONFIG.
  47.  
  48. On PR1ME sites, it is done on an ad hoc basis [ any suggestions ? ]
  49.  
  50. This updates a number of files from *.SH (.VMS on VMS) (listed in *.LST)
  51.  
  52. nrs.h:    there are various #define's that start F_ which
  53.     specify the formats you may wish to output in. Normally
  54.     you should have all these defined as the output format is
  55.     governed by the config file. However, if you have a small system
  56.     you may wish to remove the code for some types of output.
  57.     VMS21 must be set if you are using VAX VMS C 2.1 (or any VMS?)
  58.     PR1ME must be set on a PR1ME.
  59.  
  60. Makefile: (make.ccom on VMS)
  61.     holds the definative pathname for the nrs file directory
  62.     DATADIR    is the directory where the NRS database file is found
  63.     WDBM    is where wdbm lives (if you are creating york DBM files)
  64.     AWK    should be set to `awk -f' if your system does not
  65.         understand that files starting `#! command' should
  66.         be run by execing `command'
  67.  
  68. getfiles: script to fetch the derfil file from salford
  69.  
  70. *.cf:    the input configuration files.
  71.  
  72. Each of these is run by obeying the file called <filename>.SH
  73. (<filename.VMS> on VMS) for each filename ending in .SH in *.LST.
  74. However, if there is a file called <filename>.SH.local then that is used
  75. instead (not implemented on VMS). If a standard *.SH file is not
  76. suitable for your site, create *.SH.local to do what you want, and mail
  77. it to pb@uk.ac.cam.cl.
  78. If it is of general use it may be included in the next release.
  79.  
  80. On VMS sites, stdconf.com (and localconf.com) contains variables:
  81.     DERFILDIR is the directory where NRS database file is found
  82.     NRSPROG      is the file which should contain the final programme
  83.     NRSUSER   is an account on the NRS to get the database file
  84.     NRSPW     is a password on the NRS to get the database file
  85. Setting the user or password to null will cause the script to prompt
  86. each time the DERFIL file is fetched.
  87.  
  88. On PR1MEs, edit make.cpl to reflect the local filenames etc.
  89.  
  90.  
  91. When built, you hand nrs a config file (of which there should be some
  92. examples -- see *.cf) and leave it to it.
  93.  
  94. You will probably need to fetch the DERFIL2 file from salford.
  95. [make getfiles on UNIX, @make getfiles on VMS, r make -getfiles on PR1ME]
  96.  
  97. On VMS and PR1MEs this will have to be converted to a format suitable for
  98. seeks [ @make convert or r make -convert ]
  99.  
  100. More details are available from in the document nrs.ms which if
  101. formatted using the `-ms' flag (nroffed version in nrs.txt).
  102.  
  103. Please keep us up to date on changes to this code and any problems
  104. encountered.
  105.  
  106. Julian Onions <jpo@uk.ac.nott.cs>
  107.  
  108. Computer Science Group
  109. Nottingham University
  110. University Park,
  111. Nottingham,
  112. NG7 2RD
  113. Tel. +44 0602 506101 (x 3595)
  114.  
  115. Piete Brooks <pb@uk.ac.cam.cl>
  116.  
  117. University of Cambridge Computer Laboratory,
  118. Corn Exchange Street,
  119. Cambridge
  120. CB2 3QG
  121. Tel. +44 223 334659
  122.  
  123. Adrian Pell <A.R.Pell@uk.ac.reading>
  124.  
  125. Department of Computer Science
  126. University of Reading
  127. Whiteknights Park
  128. Reading
  129. RG6 2AX
  130. Tel: +44 734 875123 x 411
  131.